Skip to main content

README Editor

tip

Make sure you are familiar with Markdown first. Learn more about Markdown here.

The README is a Markdown document. It is a document providing information to your prospective users about your Widget. It might contain instructions, help, or details about the patches or updates. Throw in some example usage scenarios, troubleshooting etc.

Usage​

As you write your Markdown, a live preview will be shown on the right side of the editor.

tip

Writing a great, clear, easy to read README can go a long way in helping us to use your Widget. If your Widget makes use of Public Environment Variables, make sure to give examples, and clear usage instructions.

Images are supported, but make sure it is hosted elsewhere from a reliable link. We don't want any broken images!.

Clearly explain:

  • What the Widget does
  • What problem is it trying to solve
  • What value does it give to the user
  • Example Public Environment Variables (if any)
  • Instructions on how to use it. E.g. If the user needs to obtain a API Key
  • Limitations if any
tip

Use headings (#, ## and ### etc) to structure the document to make it easier to read!